调用DescribeSiteMonitorAttribute查询站点监控任务的详细信息

调用DescribeSiteMonitorAttribute接口查询站点监控任务的详细信息。

接口说明

本文将提供一个示例，查询站点监控任务cc641dff-c19d-45f3-ad0a-818a0c4f****的详细信息，返回结果显示，站点监控任务的名称为test123、探测地址为https://aliyun.com、运营商为阿里巴巴等信息。

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

操作：是指具体的权限点。
访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
资源类型：是指操作中支持授权的资源类型。具体说明如下：
- 对于必选的资源类型，用背景高亮的方式表示。
- 对于不支持资源级授权的操作，用全部资源表示。
条件关键字：是指云产品自身定义的条件关键字。
关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。

操作	访问级别	资源类型	条件关键字	关联操作
cms:DescribeSiteMonitorAttribute	Read	全部资源 *	无	无

请求参数

名称	类型	必填	描述	示例值
TaskId	string	是	监控任务 ID。	cc641dff-c19d-45f3-ad0a-818a0c4f****
IncludeAlert	boolean	否	返回的任务详情是否包含报警规则。 true：如果该参数的取值为 true，则返回报警规则。 false（默认值）：如果该参数的取值为 false，则不返回报警规则。	false

关于公共请求参数的详情，请参见公共参数。

返回参数

名称	类型	描述	示例值
	object	返回结果。
Code	string	状态码。说明 200 表示成功。	200
Message	string	返回信息。	successful
RequestId	string	请求 ID。	D17DF650-7EBD-54D0-903A-1D4E624D7402
Success	boolean	操作是否成功。取值： true：成功。 false：失败。	true
SiteMonitors	object	监控任务详情。
TaskType	string	监控任务类型。目前站点监控任务的类型包括：HTTP（S）、PING、TCP、UDP、DNS、SMTP、POP3、FTP。	HTTP
Interval	string	监控任务的周期。单位：分钟。取值：1、 5、15、30 和 60。	1
TaskState	string	监控任务的状态。取值： 1：启用。 2：禁用。	1
TaskName	string	监控任务名称。	test123
Address	string	监控任务的探测地址。	https://aliyun.com
TaskId	string	监控任务 ID。	cc641dff-c19d-45f3-ad0a-818a0c4f****
IspCities	object []	探测点的运营商和城市。
City	string	城市 ID。	738
IspName	string	运营商名称。	阿里巴巴
Isp	string	运营商 ID。	465
CityName	string	城市名称。	北京市
OptionJson	object	扩展选项。每一种探测类型有不同的扩展类型，详情请参见 CreateSiteMonitor 。
request_format	string	HTTP 请求内容格式。取值： hex：十六进制格式。 txt：文本格式。	txt
response_content	string	匹配响应内容。	txt
port	integer	TCP、UDP、SMTP、POP3 探测类型的端口。	110
authentication	integer	是否开启安全验证。取值： 0：否。 1：是。	1
match_rule	integer	是否包含报警规则。取值： 0：是。 1：否。	1
dns_match_rule	string	DNS 的匹配规则。取值： IN_DNS：期望解析的别名或 IP 地址均在 DNS 应答中。 DNS_IN：所有的 DNS 应答都出现在期望解析的别名或 IP 地址中。 EQUAL：DNS 应答和期望解析的别名或 IP 地址完全相同。 ANY：DNS 应答和期望解析的别名或 IP 地址有交集。	IN_DNS
request_content	string	HTTP 探测类型的请求内容。	aa=bb
username	string	FTP、SMTP 或 POP3 的用户名。	testUser
dns_type	string	DNS 解析类型。仅适用于 DNS 探测类型。取值： A：指定主机名或域名对应的 IP 地址。 CNAME：将多个域名映射到另外一个域名。 NS：指定域名由某个 DNS 服务器解析。 MX：将域名指向一个邮件服务器地址。 TXT：主机名或域名的说明。文本长度限制 512 字节，通常用做 SPF（Sender Policy Framework）记录，即反垃圾邮件。	A
response_format	string	HTTP 响应内容格式。取值： hex：十六进制格式。 txt：文本格式。	txt
password	string	SMTP、POP3 或 FTP 探测类型的密码。	123****
expect_value	string	待解析的别名或地址。说明该参数仅适用于 DNS 探测类型。	dns_server
time_out	long	超时时间。单位：毫秒。	3
failure_rate	float	丢包率。说明该参数仅适用于 PING 探测类型。	0.4
header	string	HTTP 请求头。	testKey:testValue
cookie	string	发送 HTTP 请求的 Cookie。	lang=en
ping_num	integer	PING 探测类型的心跳。	29
http_method	string	HTTP 请求方法。取值： get post head	get
dns_server	string	DNS 服务器的 IP 地址。说明仅适用于 DNS 探测类型。	192.168.XX.XX
attempts	long	DNS 失败后重试次数。	3
protocol	string	探测协议。	TCP
isBase64Encode	string	是否对密码进行 base64 解码存储。取值： true：对密码进行 base64 解码存储。 false：不对密码进行 base64 解码存储。	false
diagnosis_mtr	boolean	是否开启任务失败后的自动 MTR 网络诊断。取值： false：不开启自动 MTR 网络诊断。 true 开启自动 MTR 网络诊断。	false
diagnosis_ping	boolean	是否开启任务失败后自动 PING 网络延时探测。取值： false：不开启自动 PING 网络延时探测。 true：开启自动 PING 网络延时探测。	false
retry_delay	integer	探测失败后重试次数。	0
assertions	object []	断言配置组。
property	string	断言内容解析路径。如果断言类型为`body_json`，则路径为`json path`。如果断言类型是`body_xml`，则路径为`xml path`	json path
type	string	断言类型。取值： response_time：判定响应时间是否符合预期。 status_code：判断 HTTP 响应状态码是否符合预期。 header：判定响应 Header 中的字段是否符合预期。 body_text：通过文本字符匹配判断返回 Body 中的内容是否符合预期。 body_json：通过 JSON 解析（JSON Path）判断返回 Body 中的内容是否符合预期。 body_xml：通过 XML 解析（XPath）判断返回 Body 中的内容是否符合预期。	response_time
operator	string	断言比较操作符。取值： contains：包含。 doesNotContain：不包含。 matches：正则匹配。 doesNotMatch：正则不匹配。 is：数值等于或字符匹配相等。 isNot：不等于。 lessThan：小于。 moreThan：大于。	lessThan
target	string	断言匹配比较的目标数值或字符。	0
min_tls_version	string	最低 TLS 版本。默认支持 TLS1.2 及以上版本，TLS1.0 和 1.1 已被禁用，如仍需支持可更改配置	tlsv1.2
dns_hijack_whitelist	string	DNS 劫持配置列表。	www.taobao.com:www.taobao.com.danuoyi.tbcache.com
ping_type	string	PING 协议类型。取值： icmp tcp udp	icmp
ping_port	integer	PING 端口。适用于 TCP PING。	80
browser_insecure	boolean	是否忽略证书错误。取值： false：不忽略证书错误。 true：忽略证书错误。	false
browser_info	object []	浏览器信息。
browser	string	浏览器类型。	Chrome
device	string	屏幕类型。	laptop
traffic_hijack_element_count	integer	当发生重定向时，如果浏览器加载资源数超过这个值，则认为发生流量劫持。当该值为 0 时，不进行校验，默认值为 0。	0
traffic_hijack_element_blacklist	array	当发生重定向时，如果浏览器加载资源的 URL 与该列表中的表达能匹配，则认为发生流量劫持。
	string	当发生重定向时，如果浏览器加载资源的 URL 与该列表中的表达能匹配，则认为发生流量劫持。	www.taobao.com
traffic_hijack_element_whitelist	array	当发生重定向时，如果浏览器加载资源的 URL 与该列表中的任意一个表达式都不匹配，则认为发生流量劫持。
	string	当发生重定向时，如果浏览器加载资源的 URL 与该列表中的任意一个表达式都不匹配，则认为发生流量劫持。	www.taobao.com
blocked_url_list	array	屏蔽的资源 URL 列表。支持路径通配符。
	string	屏蔽的资源 URL 列表。支持路径通配符。	www.taobao.com/**
expect_exist_string	array	期待页面中存在的字符串列表。
	string	期待页面中存在的字符串列表。	expected string
expect_non_exist_string	array	期待页面中不存在的字符串列表。
	string	期待页面中不存在的字符串列表。	unexpected string
strict_mode	boolean	是否允许页面有元素加载失败。取值： false：表示允许页面有元素加载失败。 true：表示不允许页面有元素加载失败。	false
browser_headers	object []	自定义 Header。结构为`{"key": "somekey", "value":"somevalue"}`
	object	自定义 Header。结构为`{"key": "somekey", "value":"somevalue"}`	{"key":"value"}
browser_hosts	array	自定义 Host。结构为`{"url":"someurl", "ip":"someip"}`。
	string	自定义 Host。结构为`{"url":"someurl", "ip":"someip"}`。	{"url":"www.taobao.com","ip":"127.0.0.1"}
browser_task_version	string	浏览器拨测版本。取值： 1：单页拨测。 2：多页拨测。	1
waitTime_after_completion	integer	浏览器拨测任务中，页面打开后的额外等待时间。	3
AgentGroup	string	探测点类型。默认为 PC。取值： PC 固网 MOBILE 移动端	PC
CustomSchedule	object	自定义探测周期。只能选择周一至周日的某个时间段进行探测。
start_hour	integer	自定义探测开始时间。单位：小时。	8
end_hour	integer	自定义探测结束时间。单位：小时。	18
time_zone	string	自定义探测的时区。	local
days	array	探测日。
	integer	探测日。	1
MetricRules	object []	监控任务的报警规则。
MetricName	string	监控项名称。	Availability
EvaluationCount	string	报警重试次数。	3
Namespace	string	云服务的数据命名空间。	acs_networkmonitor
OkActions	string	收到报警的联系人组。	[ "CloudMonitor"]
AlarmActions	string	报警规则通知的报警联系组。	CloudMonitor
RuleId	string	报警规则 ID。	bf071ae_7b7aec3817b0fdf****
RuleName	string	报警规则名称。	rule1
Period	string	时间间隔。通常是监控项的上报周期，单位：秒。说明如果您设置了统计周期，则会按照此周期查询对应的统计数据。	15s
ComparisonOperator	string	报警规则的阈值比较符。取值： `>=` `>` `<=` `<` `=` `!=` GreaterThanYesterday：同比昨天同时间上涨。 LessThanYesterday：同比昨天同时间下降。 GreaterThanLastWeek：同比上周同一时间上涨。 LessThanLastWeek：同比上周同一时间下降。 GreaterThanLastPeriod：环比上周期上涨。 LessThanLastPeriod：环比上周期下降。	GreaterThanYesterday
Expression	string	报警规则的表达式。	$Availability=30
Dimensions	string	报警规则对应的维度。	[{"taskId": "cc641dff-c19d-45f3-ad0a-818a0c4f****" }]
StateValue	string	报警的状态。取值： OK：正常。 ALARM：报警。	OK
ActionEnable	string	报警规则的状态。取值： true：启用。 false：禁用。	true
Level	string	报警规则的级别。取值： 1：紧急。 2：警告。 3：信息。	2
Threshold	string	报警阈值。	30
Statistics	string	报警的统计方法。取值： Availability：可用探测点百分比。 AvailableNumber：可用探测点数量。 ErrorCodeMaximum：任意状态码（独立报警）。 ErrorCodeMinimum：所有状态码（组合报警）。 Average：响应时间。	Availability

示例

正常返回示例

JSON格式

{
  "Code": "200",
  "Message": "successful",
  "RequestId": "D17DF650-7EBD-54D0-903A-1D4E624D7402",
  "Success": true,
  "SiteMonitors": {
    "TaskType": "HTTP",
    "Interval": "1",
    "TaskState": "1",
    "TaskName": "test123",
    "Address": "https://aliyun.com",
    "TaskId": "cc641dff-c19d-45f3-ad0a-818a0c4f****",
    "IspCities": {
      "IspCity": [
        {
          "City": "738",
          "IspName": "阿里巴巴",
          "Isp": "465",
          "CityName": "北京市"
        }
      ]
    },
    "OptionJson": {
      "request_format": "txt",
      "response_content": "txt",
      "port": 110,
      "authentication": 1,
      "match_rule": 1,
      "dns_match_rule": "IN_DNS",
      "request_content": "aa=bb",
      "username": "testUser",
      "dns_type": "A",
      "response_format": "txt",
      "password": "123****",
      "expect_value": "dns_server",
      "time_out": 3,
      "failure_rate": 0.4,
      "header": "testKey:testValue",
      "cookie": "lang=en",
      "ping_num": 29,
      "http_method": "get",
      "dns_server": "192.168.XX.XX",
      "attempts": 3,
      "protocol": "TCP",
      "isBase64Encode": "false",
      "diagnosis_mtr": false,
      "diagnosis_ping": false,
      "retry_delay": 0,
      "assertions": {
        "assertions": [
          {
            "property": "json path",
            "type": "response_time",
            "operator": "lessThan",
            "target": "0"
          }
        ]
      },
      "min_tls_version": "tlsv1.2",
      "dns_hijack_whitelist": "www.taobao.com:www.taobao.com.danuoyi.tbcache.com",
      "ping_type": "icmp",
      "ping_port": 80,
      "browser_insecure": false,
      "browser_info": {
        "browser_info": [
          {
            "browser": "Chrome",
            "device": "laptop"
          }
        ]
      },
      "traffic_hijack_element_count": 0,
      "traffic_hijack_element_blacklist": {
        "traffic_hijack_element_blacklist": [
          "www.taobao.com"
        ]
      },
      "traffic_hijack_element_whitelist": {
        "traffic_hijack_element_whitelist": [
          "www.taobao.com"
        ]
      },
      "blocked_url_list": {
        "blocked_url_list": [
          "www.taobao.com/**"
        ]
      },
      "expect_exist_string": {
        "expect_exist_string": [
          "expected string"
        ]
      },
      "expect_non_exist_string": {
        "expect_non_exist_string": [
          "unexpected string"
        ]
      },
      "strict_mode": false,
      "browser_headers": {
        "browser_headers": [
          {
            "key": "value"
          }
        ]
      },
      "browser_hosts": {
        "browser_hosts": [
          "{\"url\":\"www.taobao.com\",\"ip\":\"127.0.0.1\"}"
        ]
      },
      "browser_task_version": "1",
      "waitTime_after_completion": 3,
      "ip_network": "",
      "empty_message": true
    },
    "AgentGroup": "PC",
    "CustomSchedule": {
      "start_hour": 8,
      "end_hour": 18,
      "time_zone": "local",
      "days": {
        "days": [
          1
        ]
      }
    }
  },
  "MetricRules": {
    "MetricRule": [
      {
        "MetricName": "Availability",
        "EvaluationCount": "3",
        "Namespace": "acs_networkmonitor",
        "OkActions": "[ \"CloudMonitor\"]",
        "AlarmActions": "CloudMonitor",
        "RuleId": "bf071ae_7b7aec3817b0fdf****",
        "RuleName": "rule1",
        "Period": "15s",
        "ComparisonOperator": "GreaterThanYesterday",
        "Expression": "$Availability=30",
        "Dimensions": "[{\"taskId\": \"cc641dff-c19d-45f3-ad0a-818a0c4f****\" }]",
        "StateValue": "OK",
        "ActionEnable": "true",
        "Level": "2",
        "Threshold": "30",
        "Statistics": "Availability"
      }
    ]
  }
}

错误码

HTTP status code	错误码	错误信息	描述
400	InvalidQueryParameter	%s	-
401	AccessDeniedException	You donot have sufficient access to perform this action.	-
402	LimitExceeded	The quota for this customer had been reached.	-
403	Forbidden	You are not authorized to operate the specified resource.	没有权限，请使用Ram进行授权
404	Forbidden	Task Id does not exist	-
406	ExceedingQuota	Exceeding quota limits.	-
409	%s	%s	-
429	Throttli∂ngException	The request was denied due to request throttling.	-
500	InternalError	The request processing has failed due to some unknown error.	-

访问错误中心查看更多错误码。

变更历史

变更时间

变更内容概要

操作

2024-05-16

OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
	删除错误码：401
	删除错误码：402
	删除错误码：403
	删除错误码：404
	删除错误码：406
	删除错误码：409
	删除错误码：429
	删除错误码：500
	删除错误码：503
出参	OpenAPI 返回结构发生变更。

2023-09-04

OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
	删除错误码：401
	删除错误码：402
	删除错误码：403
	删除错误码：404
	删除错误码：406
	删除错误码：409
	删除错误码：429
	删除错误码：500
	删除错误码：503
出参	OpenAPI 返回结构发生变更。

2023-08-22

OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
	删除错误码：401
	删除错误码：402
	删除错误码：403
	删除错误码：404
	删除错误码：406
	删除错误码：409
	删除错误码：429
	删除错误码：500
	删除错误码：503
出参	OpenAPI 返回结构发生变更。

2023-08-04

OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
	删除错误码：401
	删除错误码：402
	删除错误码：403
	删除错误码：404
	删除错误码：406
	删除错误码：409
	删除错误码：429
	删除错误码：500
	删除错误码：503
出参	OpenAPI 返回结构发生变更。

2023-06-15

OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
	删除错误码：401
	删除错误码：402
	删除错误码：403
	删除错误码：404
	删除错误码：406
	删除错误码：409
	删除错误码：429
	删除错误码：500
	删除错误码：503
出参	OpenAPI 返回结构发生变更。

2023-05-22

OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
	删除错误码：401
	删除错误码：402
	删除错误码：403
	删除错误码：404
	删除错误码：406
	删除错误码：409
	删除错误码：429
	删除错误码：500
	删除错误码：503
出参	OpenAPI 返回结构发生变更。

2023-04-06

OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
	删除错误码：401
	删除错误码：402
	删除错误码：403
	删除错误码：404
	删除错误码：406
	删除错误码：409
	删除错误码：429
	删除错误码：500
	删除错误码：503
出参	OpenAPI 返回结构发生变更。

2021-09-16

OpenAPI 描述信息更新、OpenAPI 错误码发生变更、OpenAPI 返回结构发生变更

看变更集

变更项	变更内容
API 描述	OpenAPI 描述信息更新。
错误码	OpenAPI 错误码发生变更。
	删除错误码：400
	删除错误码：401
	删除错误码：402
	删除错误码：403
	删除错误码：404
	删除错误码：406
	删除错误码：409
	删除错误码：429
	删除错误码：500
	删除错误码：503
出参	OpenAPI 返回结构发生变更。